
// ToolsLib Project

/* ToolsLib library for RusRoute firewall and other projects of
 * Andrey A. Moiseenko / IE Moiseenko A.A. (Russia)
 * e-mail: support@maasoftware.ru, maa2002@mail.ru
 * web: http://maasoftware.ru, http://maasoftware.com, http://maasoft.ru, http://maasoft.org
 * Author's full name: Andrey Alekseevitch Moiseenko
 * (russian name: Моисеенко Андрей Алексеевич)
 */

// ToolsLib/Refs.h

/* Copyright (C) 2002-2024 Andrey A. Moiseenko (support@maasoftware.ru)
 * All rights reserved.
 *
 * This library contains cross-platform class for simple reference count
 * implementation.
 * The library implementation written
 * by Andrey A. Moiseenko (support@maasoftware.ru).
 * This library and applications are
 * FREE FOR COMMERCIAL AND NON-COMMERCIAL USE
 * as long as the following conditions are aheared to.
 *
 * Copyright remains Andrey A. Moiseenko, and as such any Copyright notices in
 * the code are not to be removed.  If this code is used in a product,
 * Andrey A. Moiseenko should be given attribution as the author of the parts used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    This product includes software developed by Andrey A. Moiseenko (support@maasoftware.ru)
 *
 * THIS SOFTWARE IS PROVIDED BY ANDREY A. MOISEENKO ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

#ifndef __TOOLS_REFS_H
#define __TOOLS_REFS_H

//#define MTX_INTERLOCKS

#if defined(_WIN32) && defined(MTX_INTERLOCKS)
typedef long TOOLSLIB_REFS_TYPE;
#else
typedef int TOOLSLIB_REFS_TYPE;
#endif

//------------------------------------------------------------------------------
// class CMaaReference
//------------------------------------------------------------------------------
class ToolsExport CMaaReference
{
public:
    CMaaReference() noexcept
    :   m_lRefs(1)
    {
    }

    // _true if and only if ONE reference encountered
    // i.e. you have no restrictions in object modification
    // In addition You need to use synchronization dealing multithread under Windows
    bool IsSingleOwner() const noexcept
    {
        return GetRefsCount__() == 1;
    }

    virtual TOOLSLIB_REFS_TYPE AddRef() noexcept;
    virtual TOOLSLIB_REFS_TYPE Release() noexcept;

    TOOLSLIB_REFS_TYPE GetRefsCount__() const noexcept
    {
#ifdef MTX_INTERLOCKS
        return m_lRefs;
#else
#ifdef TOOLSLIB_SINGLE_THREAD
        return m_lRefs;
#else
        return m_lRefs.load();
#endif
#endif
    }
    static void CheckImplementation ( const CMaaReference * pRef );

protected:
    virtual ~CMaaReference() noexcept {}

private:
#ifdef MTX_INTERLOCKS
    TOOLSLIB_REFS_TYPE m_lRefs;
#else
#ifdef TOOLSLIB_SINGLE_THREAD
    TOOLSLIB_REFS_TYPE m_lRefs;
#else
    std::atomic<TOOLSLIB_REFS_TYPE> m_lRefs;
#endif
#endif
};

//------------------------------------------------------------------------------
// class CMaaManualReference // non-virtual manual delete Reference
//------------------------------------------------------------------------------
class ToolsExport CMaaManualReference
{
public:
    CMaaManualReference() noexcept
    :   m_lRefs(1)
    {
    }

    // _true if and only if ONE reference encountered
    // i.e. you have no restrictions in object modification
    // In addition You need to use synchronization dealing multithread under Windows
    bool IsSingleOwner() const noexcept
    {
        return GetRefsCount__() == 1;
    }

    TOOLSLIB_REFS_TYPE AddRef() noexcept;
    TOOLSLIB_REFS_TYPE Release() noexcept;

    TOOLSLIB_REFS_TYPE GetRefsCount__() const noexcept
    {
#ifdef MTX_INTERLOCKS
        return m_lRefs;
#else
#ifdef TOOLSLIB_SINGLE_THREAD
        return m_lRefs;
#else
        return m_lRefs.load();
#endif
#endif
    }
    static void CheckImplementation(const CMaaManualReference* pRef);

protected:
    ~CMaaManualReference() noexcept {}

private:
#ifdef MTX_INTERLOCKS
    TOOLSLIB_REFS_TYPE m_lRefs;
#else
#ifdef TOOLSLIB_SINGLE_THREAD
    TOOLSLIB_REFS_TYPE m_lRefs;
#else
    std::atomic<TOOLSLIB_REFS_TYPE> m_lRefs;
#endif
#endif
};

//------------------------------------------------------------------------------
// class CMaaManualReference // non-virtual manual delete Reference
//------------------------------------------------------------------------------
class ToolsExport CMaaManualReferenceDLink : public CMaaDLink
{
public:
    CMaaManualReferenceDLink() noexcept
    :   m_lRefs(1)
    {
    }

    // _true if and only if ONE reference encountered
    // i.e. you have no restrictions in object modification
    // In addition You need to use synchronization dealing multithread under Windows
    bool IsSingleOwner() const noexcept
    {
        return GetRefsCount__() == 1;
    }

    TOOLSLIB_REFS_TYPE AddRef() noexcept;
    TOOLSLIB_REFS_TYPE Release() noexcept;

    TOOLSLIB_REFS_TYPE GetRefsCount__() const noexcept
    {
#ifdef MTX_INTERLOCKS
        return m_lRefs;
#else
#ifdef TOOLSLIB_SINGLE_THREAD
        return m_lRefs;
#else
        return m_lRefs.load();
#endif
#endif
    }
    static void CheckImplementation(const CMaaManualReferenceDLink* pRef);

protected:
    ~CMaaManualReferenceDLink() noexcept {}

private:
#ifdef MTX_INTERLOCKS
    TOOLSLIB_REFS_TYPE m_lRefs;
#else
#ifdef TOOLSLIB_SINGLE_THREAD
    TOOLSLIB_REFS_TYPE m_lRefs;
#else
    std::atomic<TOOLSLIB_REFS_TYPE> m_lRefs;
#endif
#endif
};


#endif // __TOOLS_REFS_H

//==============================================================================
